<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.beanutils;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.lang.reflect.InvocationTargetException;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.Serializable;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.Comparator;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.commons.collections.comparators.ComparableComparator;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    /**<a name="line.25"></a>
<FONT color="green">026</FONT>     * &lt;p&gt;<a name="line.26"></a>
<FONT color="green">027</FONT>     * This comparator compares two beans by the specified bean property. <a name="line.27"></a>
<FONT color="green">028</FONT>     * It is also possible to compare beans based on nested, indexed, <a name="line.28"></a>
<FONT color="green">029</FONT>     * combined, mapped bean properties. Please see the {@link PropertyUtilsBean} <a name="line.29"></a>
<FONT color="green">030</FONT>     * documentation for all property name possibilities. <a name="line.30"></a>
<FONT color="green">031</FONT>     *<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;/p&gt;&lt;p&gt;<a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;strong&gt;Note:&lt;/strong&gt; The BeanComparator passes the values of the specified <a name="line.33"></a>
<FONT color="green">034</FONT>     * bean property to a ComparableComparator, if no comparator is <a name="line.34"></a>
<FONT color="green">035</FONT>     * specified in the constructor. If you are comparing two beans based <a name="line.35"></a>
<FONT color="green">036</FONT>     * on a property that could contain "null" values, a suitable &lt;code&gt;Comparator&lt;/code&gt; <a name="line.36"></a>
<FONT color="green">037</FONT>     * or &lt;code&gt;ComparatorChain&lt;/code&gt; should be supplied in the constructor. <a name="line.37"></a>
<FONT color="green">038</FONT>     * &lt;/p&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     *<a name="line.39"></a>
<FONT color="green">040</FONT>     * @author     &lt;a href"mailto:epugh@upstate.com"&gt;Eric Pugh&lt;/a&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * @author Tim O'Brien <a name="line.41"></a>
<FONT color="green">042</FONT>     */<a name="line.42"></a>
<FONT color="green">043</FONT>    public class BeanComparator implements Comparator, Serializable {<a name="line.43"></a>
<FONT color="green">044</FONT>    <a name="line.44"></a>
<FONT color="green">045</FONT>        private String property;<a name="line.45"></a>
<FONT color="green">046</FONT>        private Comparator comparator;<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>        /** <a name="line.48"></a>
<FONT color="green">049</FONT>         * &lt;p&gt;Constructs a Bean Comparator without a property set.<a name="line.49"></a>
<FONT color="green">050</FONT>         * &lt;/p&gt;&lt;p&gt;<a name="line.50"></a>
<FONT color="green">051</FONT>         * &lt;strong&gt;Note&lt;/strong&gt; that this is intended to be used <a name="line.51"></a>
<FONT color="green">052</FONT>         * only in bean-centric environments.<a name="line.52"></a>
<FONT color="green">053</FONT>         * &lt;/p&gt;&lt;p&gt;<a name="line.53"></a>
<FONT color="green">054</FONT>         * Until {@link #setProperty} is called with a non-null value.<a name="line.54"></a>
<FONT color="green">055</FONT>         * this comparator will compare the Objects only.<a name="line.55"></a>
<FONT color="green">056</FONT>         * &lt;/p&gt;<a name="line.56"></a>
<FONT color="green">057</FONT>         */<a name="line.57"></a>
<FONT color="green">058</FONT>        public BeanComparator() {<a name="line.58"></a>
<FONT color="green">059</FONT>            this( null );<a name="line.59"></a>
<FONT color="green">060</FONT>        }<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>        /**<a name="line.62"></a>
<FONT color="green">063</FONT>         * &lt;p&gt;Constructs a property-based comparator for beans.<a name="line.63"></a>
<FONT color="green">064</FONT>         * This compares two beans by the property <a name="line.64"></a>
<FONT color="green">065</FONT>         * specified in the property parameter. This constructor creates <a name="line.65"></a>
<FONT color="green">066</FONT>         * a &lt;code&gt;BeanComparator&lt;/code&gt; that uses a &lt;code&gt;ComparableComparator&lt;/code&gt;<a name="line.66"></a>
<FONT color="green">067</FONT>         * to compare the property values. <a name="line.67"></a>
<FONT color="green">068</FONT>         * &lt;/p&gt;<a name="line.68"></a>
<FONT color="green">069</FONT>         * <a name="line.69"></a>
<FONT color="green">070</FONT>         * &lt;p&gt;Passing "null" to this constructor will cause the BeanComparator <a name="line.70"></a>
<FONT color="green">071</FONT>         * to compare objects based on natural order, that is <a name="line.71"></a>
<FONT color="green">072</FONT>         * &lt;code&gt;java.lang.Comparable&lt;/code&gt;. <a name="line.72"></a>
<FONT color="green">073</FONT>         * &lt;/p&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>         *<a name="line.74"></a>
<FONT color="green">075</FONT>         * @param property String Name of a bean property, which may contain the <a name="line.75"></a>
<FONT color="green">076</FONT>         * name of a simple, nested, indexed, mapped, or combined <a name="line.76"></a>
<FONT color="green">077</FONT>         * property. See {@link PropertyUtilsBean} for property query language syntax. <a name="line.77"></a>
<FONT color="green">078</FONT>         * If the property passed in is null then the actual objects will be compared<a name="line.78"></a>
<FONT color="green">079</FONT>         */<a name="line.79"></a>
<FONT color="green">080</FONT>        public BeanComparator( String property ) {<a name="line.80"></a>
<FONT color="green">081</FONT>            this( property, ComparableComparator.getInstance() );<a name="line.81"></a>
<FONT color="green">082</FONT>        }<a name="line.82"></a>
<FONT color="green">083</FONT>    <a name="line.83"></a>
<FONT color="green">084</FONT>        /**<a name="line.84"></a>
<FONT color="green">085</FONT>         * Constructs a property-based comparator for beans.<a name="line.85"></a>
<FONT color="green">086</FONT>         * This constructor creates <a name="line.86"></a>
<FONT color="green">087</FONT>         * a BeanComparator that uses the supplied Comparator to compare <a name="line.87"></a>
<FONT color="green">088</FONT>         * the property values. <a name="line.88"></a>
<FONT color="green">089</FONT>         * <a name="line.89"></a>
<FONT color="green">090</FONT>         * @param property Name of a bean property, can contain the name <a name="line.90"></a>
<FONT color="green">091</FONT>         * of a simple, nested, indexed, mapped, or combined <a name="line.91"></a>
<FONT color="green">092</FONT>         * property. See {@link PropertyUtilsBean} for property query language  <a name="line.92"></a>
<FONT color="green">093</FONT>         * syntax. <a name="line.93"></a>
<FONT color="green">094</FONT>         * @param comparator BeanComparator will pass the values of the <a name="line.94"></a>
<FONT color="green">095</FONT>         * specified bean property to this Comparator. <a name="line.95"></a>
<FONT color="green">096</FONT>         * If your bean property is not a comparable or <a name="line.96"></a>
<FONT color="green">097</FONT>         * contains null values, a suitable comparator <a name="line.97"></a>
<FONT color="green">098</FONT>         * may be supplied in this constructor.<a name="line.98"></a>
<FONT color="green">099</FONT>         */<a name="line.99"></a>
<FONT color="green">100</FONT>        public BeanComparator( String property, Comparator comparator ) {<a name="line.100"></a>
<FONT color="green">101</FONT>            setProperty( property );<a name="line.101"></a>
<FONT color="green">102</FONT>            if (comparator != null) {<a name="line.102"></a>
<FONT color="green">103</FONT>                this.comparator = comparator;<a name="line.103"></a>
<FONT color="green">104</FONT>            } else {<a name="line.104"></a>
<FONT color="green">105</FONT>                this.comparator = ComparableComparator.getInstance();<a name="line.105"></a>
<FONT color="green">106</FONT>            }<a name="line.106"></a>
<FONT color="green">107</FONT>        }<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>        /**<a name="line.109"></a>
<FONT color="green">110</FONT>         * Sets the method to be called to compare two JavaBeans<a name="line.110"></a>
<FONT color="green">111</FONT>         *<a name="line.111"></a>
<FONT color="green">112</FONT>         * @param property String method name to call to compare <a name="line.112"></a>
<FONT color="green">113</FONT>         * If the property passed in is null then the actual objects will be compared<a name="line.113"></a>
<FONT color="green">114</FONT>         */<a name="line.114"></a>
<FONT color="green">115</FONT>        public void setProperty( String property ) {<a name="line.115"></a>
<FONT color="green">116</FONT>            this.property = property;<a name="line.116"></a>
<FONT color="green">117</FONT>        }<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>    <a name="line.119"></a>
<FONT color="green">120</FONT>        /**<a name="line.120"></a>
<FONT color="green">121</FONT>         * Gets the property attribute of the BeanComparator<a name="line.121"></a>
<FONT color="green">122</FONT>         *<a name="line.122"></a>
<FONT color="green">123</FONT>         * @return String method name to call to compare. <a name="line.123"></a>
<FONT color="green">124</FONT>         * A null value indicates that the actual objects will be compared<a name="line.124"></a>
<FONT color="green">125</FONT>         */<a name="line.125"></a>
<FONT color="green">126</FONT>        public String getProperty() {<a name="line.126"></a>
<FONT color="green">127</FONT>            return property;<a name="line.127"></a>
<FONT color="green">128</FONT>        }<a name="line.128"></a>
<FONT color="green">129</FONT>    <a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>        /**<a name="line.131"></a>
<FONT color="green">132</FONT>         * Gets the Comparator being used to compare beans.<a name="line.132"></a>
<FONT color="green">133</FONT>         *<a name="line.133"></a>
<FONT color="green">134</FONT>         * @return the Comparator being used to compare beans <a name="line.134"></a>
<FONT color="green">135</FONT>         */<a name="line.135"></a>
<FONT color="green">136</FONT>        public Comparator getComparator() {<a name="line.136"></a>
<FONT color="green">137</FONT>            return comparator;<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>    <a name="line.140"></a>
<FONT color="green">141</FONT>        /**<a name="line.141"></a>
<FONT color="green">142</FONT>         * Compare two JavaBeans by their shared property.<a name="line.142"></a>
<FONT color="green">143</FONT>         * If {@link #getProperty} is null then the actual objects will be compared.<a name="line.143"></a>
<FONT color="green">144</FONT>         *<a name="line.144"></a>
<FONT color="green">145</FONT>         * @param  o1 Object The first bean to get data from to compare against<a name="line.145"></a>
<FONT color="green">146</FONT>         * @param  o2 Object The second bean to get data from to compare<a name="line.146"></a>
<FONT color="green">147</FONT>         * @return int negative or positive based on order<a name="line.147"></a>
<FONT color="green">148</FONT>         */<a name="line.148"></a>
<FONT color="green">149</FONT>        public int compare( Object o1, Object o2 ) {<a name="line.149"></a>
<FONT color="green">150</FONT>            <a name="line.150"></a>
<FONT color="green">151</FONT>            if ( property == null ) {<a name="line.151"></a>
<FONT color="green">152</FONT>                // compare the actual objects<a name="line.152"></a>
<FONT color="green">153</FONT>                return comparator.compare( o1, o2 );<a name="line.153"></a>
<FONT color="green">154</FONT>            }<a name="line.154"></a>
<FONT color="green">155</FONT>            <a name="line.155"></a>
<FONT color="green">156</FONT>            try {<a name="line.156"></a>
<FONT color="green">157</FONT>                Object value1 = PropertyUtils.getProperty( o1, property );<a name="line.157"></a>
<FONT color="green">158</FONT>                Object value2 = PropertyUtils.getProperty( o2, property );<a name="line.158"></a>
<FONT color="green">159</FONT>                return comparator.compare( value1, value2 );<a name="line.159"></a>
<FONT color="green">160</FONT>            }<a name="line.160"></a>
<FONT color="green">161</FONT>            catch ( IllegalAccessException iae ) {<a name="line.161"></a>
<FONT color="green">162</FONT>                throw new RuntimeException( "IllegalAccessException: " + iae.toString() );<a name="line.162"></a>
<FONT color="green">163</FONT>            } <a name="line.163"></a>
<FONT color="green">164</FONT>            catch ( InvocationTargetException ite ) {<a name="line.164"></a>
<FONT color="green">165</FONT>                throw new RuntimeException( "InvocationTargetException: " + ite.toString() );<a name="line.165"></a>
<FONT color="green">166</FONT>            }<a name="line.166"></a>
<FONT color="green">167</FONT>            catch ( NoSuchMethodException nsme ) {<a name="line.167"></a>
<FONT color="green">168</FONT>                throw new RuntimeException( "NoSuchMethodException: " + nsme.toString() );<a name="line.168"></a>
<FONT color="green">169</FONT>            } <a name="line.169"></a>
<FONT color="green">170</FONT>        }<a name="line.170"></a>
<FONT color="green">171</FONT>        <a name="line.171"></a>
<FONT color="green">172</FONT>        /**<a name="line.172"></a>
<FONT color="green">173</FONT>         * Two &lt;code&gt;BeanComparator&lt;/code&gt;'s are equals if and only if<a name="line.173"></a>
<FONT color="green">174</FONT>         * the wrapped comparators and the property names to be compared<a name="line.174"></a>
<FONT color="green">175</FONT>         * are equal.<a name="line.175"></a>
<FONT color="green">176</FONT>         * @param  o Comparator to compare to<a name="line.176"></a>
<FONT color="green">177</FONT>         * @return whether the the comparators are equal or not<a name="line.177"></a>
<FONT color="green">178</FONT>         */<a name="line.178"></a>
<FONT color="green">179</FONT>        public boolean equals(Object o) {<a name="line.179"></a>
<FONT color="green">180</FONT>            if (this == o) {<a name="line.180"></a>
<FONT color="green">181</FONT>                return true;<a name="line.181"></a>
<FONT color="green">182</FONT>            }<a name="line.182"></a>
<FONT color="green">183</FONT>            if (!(o instanceof BeanComparator)) {<a name="line.183"></a>
<FONT color="green">184</FONT>                return false;<a name="line.184"></a>
<FONT color="green">185</FONT>            }<a name="line.185"></a>
<FONT color="green">186</FONT>    <a name="line.186"></a>
<FONT color="green">187</FONT>            final BeanComparator beanComparator = (BeanComparator) o;<a name="line.187"></a>
<FONT color="green">188</FONT>    <a name="line.188"></a>
<FONT color="green">189</FONT>            if (!comparator.equals(beanComparator.comparator)) {<a name="line.189"></a>
<FONT color="green">190</FONT>                return false;<a name="line.190"></a>
<FONT color="green">191</FONT>            }<a name="line.191"></a>
<FONT color="green">192</FONT>            if (property != null)<a name="line.192"></a>
<FONT color="green">193</FONT>            {<a name="line.193"></a>
<FONT color="green">194</FONT>                if (!property.equals(beanComparator.property)) {<a name="line.194"></a>
<FONT color="green">195</FONT>                    return false;<a name="line.195"></a>
<FONT color="green">196</FONT>                }<a name="line.196"></a>
<FONT color="green">197</FONT>            }<a name="line.197"></a>
<FONT color="green">198</FONT>            else<a name="line.198"></a>
<FONT color="green">199</FONT>            {<a name="line.199"></a>
<FONT color="green">200</FONT>                return (beanComparator.property == null);<a name="line.200"></a>
<FONT color="green">201</FONT>            }<a name="line.201"></a>
<FONT color="green">202</FONT>    <a name="line.202"></a>
<FONT color="green">203</FONT>            return true;<a name="line.203"></a>
<FONT color="green">204</FONT>        }<a name="line.204"></a>
<FONT color="green">205</FONT>    <a name="line.205"></a>
<FONT color="green">206</FONT>        /**<a name="line.206"></a>
<FONT color="green">207</FONT>         * Hashcode compatible with equals.<a name="line.207"></a>
<FONT color="green">208</FONT>         * @return the hash code for this comparator<a name="line.208"></a>
<FONT color="green">209</FONT>         */ <a name="line.209"></a>
<FONT color="green">210</FONT>        public int hashCode() {<a name="line.210"></a>
<FONT color="green">211</FONT>            int result;<a name="line.211"></a>
<FONT color="green">212</FONT>            result = comparator.hashCode();<a name="line.212"></a>
<FONT color="green">213</FONT>            return result;<a name="line.213"></a>
<FONT color="green">214</FONT>        }<a name="line.214"></a>
<FONT color="green">215</FONT>    }<a name="line.215"></a>




























































</PRE>
</BODY>
</HTML>
